home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / SOUND / MATTRK1 / !S3M2MTRX / !Help < prev    next >
Text File  |  1996-04-04  |  11KB  |  283 lines
  1. ————————————————————————————————————————————————————————————————————ALT+152——
  2.  
  3. matrixTRK                          ••••••   ••••••
  4.                                •••••• ••••••
  5. 1..32 voices                              ••• •••
  6. song player module v0.85                      ••• •••
  7.                                   ••• •••
  8. PreRelease                              ••• •••
  9.                                   ••• ••• matrix
  10.  
  11. —————————————————————————————————————————————————————————————————————————————
  12. Contents
  13.  
  14.  Introduction
  15.  Package file list
  16.  Song player module usage
  17.  Song file converter
  18.  Note
  19.  Features of the full version
  20.  Future enhancement
  21.  Why do we use an own file format?
  22.  Copyright
  23.  Contact
  24.  
  25. —————————————————————————————————————————————————————————————————————————————
  26. Introduction
  27.  
  28. 1992: In Chemnitz (Germany) there were 2 Coders Marko Lukat (blackICe) and
  29. Michael Pohle (Lord of the earwigs) who came together to realize their first
  30. production. It was `Rubik's Cube´ written in Assembler on Intel PC. But all
  31. the code was neither well optimized nor very fast and the sound routine could
  32. not play all the PROTracker effects. Later blackICe bought an A5000 and we've
  33. released our first Demo called `!cMemc´ on the Cebit 1993. The Demo is based
  34. on an special effect of the Memory Controller. The main code was written by
  35. blackICe. To play a song within the Demo it was neccessary to patch the Sound
  36. DMA handler (not yet fixed in RiscOS 3.5, shame on Acorn). Due to a lack of
  37. available song players with the ability to run under special timing
  38. conditions we've had to code our own song play routine.
  39.  
  40. The first version of matrixTRK was coded by 'Lord of the earwigs'. Followed
  41. by many steps in development of matrixTRK now we present a new version with
  42. new features which are described in this documentation. Additionally you will
  43. get full information about the file format, the SWI- and CLI- Interface and
  44. about useful utilities. If any problems, bugs etc. will occur while using the
  45. matrixTRK module do not hesitate to contact the authors (addresses in the
  46. last section).
  47.  
  48. —————————————————————————————————————————————————————————————————————————————
  49. Package file list
  50.  
  51. matrixTRK will be distributed in 4 packages (ZIP-archives,roughly 660K each):
  52.  
  53. - mtrxTRK1.ZIP, mtrxTRK2.ZIP, mtrxTRK3.ZIP, mtrxTRK4.ZIP.
  54.  
  55. These archives contain all the necessary module and document stuff besides
  56. a couple of demo songs. After decrunching the following structure should be
  57. available:
  58.  
  59. !S3M2MTRX            -> Application directory
  60.     !Boot
  61.     !Help            -> this file
  62.     !Run
  63.     !Sprites
  64.     !Sprites22
  65.     Link            -> Work directory
  66.     Docs            -> directory
  67.         !FXSpec        -> sound effect description
  68.         !TRKSpec        -> matrixTRK specification
  69.         !Validity        -> error code explanation
  70.         ST3Doc        -> stuff to scream about :-)
  71.         ST3TechDoc        -> guess ...
  72.         WorkSpace        -> workspace structure
  73.     Resources        -> directory
  74.         Convert        -> task obey for WIMP
  75.         matrixLink        -> matrix SWI server
  76.         matrixSQSH        -> backend for Squash
  77.         matrixTRK        -> 1...8 voices player module, optimized
  78.         mtrxTRK32        -> 1..32 voices player module, prerelease
  79.         S3M2MTRX        -> ScreamTracker 3.xx file converter
  80.     Songs            -> directory
  81.         matrixTRK        -> directory
  82.         ¥2ND_PM        ->  8 voices, packed pattern, *****
  83.         ¥2ND_SKAV    ->  8 voices, packed pattern, *****
  84.         ¥CHARIOT    -> 16 voices, packed pattern, ***+
  85.         ¥CTGOBLIN    -> 12 voices, packed pattern, ****+
  86.         ¥FM-SCRAP    -> 16 voices, packed pattern, ****+
  87.         ¥NOTC        ->  8 voices, packed pattern, ****+
  88.         S3M            -> directory
  89.         WAR-REM        ->  9 voices,              ***
  90.         YUME        -> 11 voices,              ***+
  91.  
  92. —————————————————————————————————————————————————————————————————————————————
  93. Song player module usage
  94.  
  95. matrixTRK is a new song player for the Archimedes and RiscPC. To get started
  96. you only have to double click the !S3M2MTRX application icon. The directory
  97. S3MConvert:Link will be opened. There are the subdirectories Docs, Resources
  98. and Songs. Open the Song.matrixTRK directory. But before enjoying the cool
  99. songs by double clicking them pump up the volume on your amplifier. By
  100. default the player module for 8 voices is loaded. If you want to hear songs
  101. with more than 8 voices you have to load the mtrxTRK32 module that you can
  102. find in the directory Resources.
  103.  
  104. Note:
  105.  
  106. By default a sample period of 48 microseconds is used. That means a replay
  107. rate of 20833 Hz. On slow Archimedes computers with a high number of voices
  108. you'd like to change that value by using the appropriate SWI:
  109.  
  110.  SYS"matrix_TRKSamplePeriod",xxx
  111.  
  112. The value of xxx can be 3 (333.333 kHz, 1 channel) ... 255. The sample period
  113. should be a multiple of the hardvoices and not less than 3us*hardvoices else
  114. the song may sound funny. If you change the value whilst playing a song, it
  115. will be restarted due to the song history with the new sample period. The
  116. more the number of voices the higher xxx should be ! Just try it.
  117.  
  118. —————————————————————————————————————————————————————————————————————————————
  119. Song file converter
  120.  
  121. You can't listen directly to S3M 'cos matrixTRK has it's own file format. So
  122. you have to convert S3M to matrixTRK. That's quite simple. The S3M file type
  123. is Data (&FFD) by default. Double click on an S3M file and it will be
  124. converted. The destination file has the type &00B (matrixT) and will be
  125. stored in the same directory as the source. Try the S3M file YUME in the
  126. directory Songs.S3M to test the converter. For more details about the
  127. converter see the !Run file. There are also information about the converter
  128. options variable.
  129.  
  130. —————————————————————————————————————————————————————————————————————————————
  131. Note:
  132.  
  133. - Releasing the full version of matrixTRK will take a while because we don't
  134. have much time to continue coding (diploma).
  135.  
  136. - Do not delete your original S3M files because the file format of matrixTRK
  137. is temporary and will be enhanced very soon.
  138.  
  139. - If the 32 voices player version is active 8 hardware voices are necessary
  140. else the song will be muted (changes via Sound_Configure).
  141.  
  142. - matrixTRK does not disable interrupts while filling the DMA-buffer. That's
  143. why disk accesses may jam the sound output (could be fixed if neccessary).
  144.  
  145. - A preRiscPC ModeChange ServiceCall handler isn't implemented yet. It'll
  146. deal with this lovely 25.175MHz frequency.
  147.  
  148. - What's wrong if the last song part of a S3M file sounds strange? That could
  149. have the following reason: the last song sequence entry in S3M files is &FF.
  150. matrixTRK ignores that and plays the next sequence entry until the end of the
  151. sequence. These (hidden) parts may sound strange, indeed.
  152.  
  153. - After the song end perhaps it will be restarted with wrong speed and tempo.
  154.  
  155. - Stereo positions currently aren't valid whilst playing a song with more
  156. than 8 voices.
  157.  
  158. - An effect for setting the stereo position isn't implemented yet.
  159.  
  160. - If you want to get more S3M songs via Internet contact ftp.uni-paderborn.de
  161. (look for pc-demos...).
  162.  
  163. - The prerelease only supports 8 bit samples.
  164.  
  165. —————————————————————————————————————————————————————————————————————————————
  166. Features of the full version (many features are implemented in the
  167. PreRelease, too)
  168.  
  169. File handling:
  170.  
  171. - Detailed file validation error description in file !Validity.
  172.  
  173. - Reducing sample data to fit a song module into less memory than originally
  174. needed.
  175.  
  176. - Detailed interface description of matrixTRK for coders.
  177.  
  178.  
  179. Sound system:
  180.  
  181. - Automatical detection of the replay rate for your Acorn Computer.
  182.  
  183. - DMA buffer resizing while playing a song is possible (as you like it).
  184.  
  185. - Support of all Acorn sound system replay rates from 3.921 kHz up to 333.333
  186. kHz. But: no dynamic change is possible because of the song history. Changing
  187. the replay rate whilst playing a song results in restarting the song.
  188.  
  189.  
  190. Player module:
  191.  
  192. - Flexible pattern length supported.
  193.  
  194. - Volume column sound effects additionally to normal sound effects supported
  195. (see file !FXDoc in the Doc directory for currently supported effects).
  196.  
  197. - Note range reaches from C-0 up to B-7 (8 octaves).
  198.  
  199. - Fine tuning of the samples using 2 parameters (pitch and sample rate).
  200.  
  201. - Samples with sample rates up to 65.535 kHz and 1 MB length (16 MB are
  202. possible if it's needed) supported.
  203.  
  204. - 8...16 Bit sample depth supported.
  205.  
  206. - Optimized 32 voices player module with dynamic memory management.
  207.  
  208. - Redirection of the song output to a file.
  209.  
  210. Song file converter:
  211.  
  212. - Packed pattern output of S3M2MTRX converter.
  213.  
  214. - Intelligent stereo attachment and song optimization.
  215.  
  216. - PROTracker file converter (MOD-format with voice numbers from 1...32).
  217.  
  218. —————————————————————————————————————————————————————————————————————————————
  219. Why do we use an own file format?
  220.  
  221. That question you will have in your mind. There are a few points. Before you
  222. can listen to your favorite song file a few loader actions must be done. At
  223. first we have to validate the file and then it can be loaded. The parts of
  224. our file format can be packed with up to 8 different packing schemes. It is
  225. possible that you can encrypt your special song file by using an own packer
  226. that will be supported by our loader. An detailed interface description you
  227. will get with the full version. Our player I think is the right thing for
  228. programmers of games and demos because it is universal in every way and takes
  229. less processor capacity than the most other players around. If we want to
  230. expand the functionality of our player to support other song module types we
  231. simply add a few new chunks into the existing file format instead of writing
  232. a complete new loader and validation routine in Assembler. But you are right
  233. - a converter is needed, indeed, but it is easier to code it in BASIC or C.
  234. That takes less time. Now try to find these features in the S3M file format.
  235.  
  236. If you want to know more details please refer to the files in the directory
  237. 'Doc' or contact us.
  238.  
  239. —————————————————————————————————————————————————————————————————————————————
  240. Future enhancement:
  241.  
  242. - XM support!
  243.  
  244. If you have any ideas what we can do to make matrixTRK perfect - let us know.
  245. Another point is that no frontend and song editor are available. But there is
  246. no time to code such things, sorry.
  247.  
  248. —————————————————————————————————————————————————————————————————————————————
  249. Copyright
  250.  
  251. Copyright of the matrixTRK and matrixLink modules is owned by matrix. We
  252. offer no guarantees as to the reliability/stability of the modules mentioned
  253. above or any of their functions.
  254.  
  255. You may copy the modules freely provided that they remain unaltered.
  256.  
  257. You may not sell the program without our written permission. However, Public
  258. Domain libraries may distribute the program provided they charge at most 3
  259. pounds sterling per disk. If anyone else would like to distribute matrixTRK
  260. and matrixLink then please write to us first to get our permission.
  261.  
  262. —————————————————————————————————————————————————————————————————————————————
  263. Contacts
  264.  
  265.  Lord of the earwigs
  266.  
  267.  Michael Pohle
  268.  Bahnhofstraße 20
  269.  04626 Nöbdenitz
  270.  Germany
  271.  
  272.  email: michael.pohle@e-technik.tu-chemnitz.de
  273.                               ••••••   ••••••
  274.  blackICe                           •••••• ••••••
  275.                                   ••• •••
  276.  Marko Lukat                              ••• •••
  277.  Venise-Gosnat-Straße 48                      ••• •••
  278.  14770 Brandenburg an der Havel                      ••• •••
  279.  Germany                              ••• ••• matrix
  280.  
  281. —————————————————————————————————————————————————————————————————————————————
  282.  
  283.  edited by blackICe and `Lord of the earwigs´ Wed 03rd April 1996